home *** CD-ROM | disk | FTP | other *** search
/ Network PC / Network PC.iso / amiga utilities / misc / add-ons / xipaintmodule / hhsxipaintmod.readme < prev    next >
Encoding:
Text File  |  1997-11-20  |  16.1 KB  |  350 lines
  1. HHsFastUniversalXiPaintModule 4.3 (incl. PhotoCD- & TrueColorAnim-support)
  2. =================================
  3.  
  4. new in V4.x: Downscaled loading support: Loading big pictures in downscaled
  5.         form can save much memory and time. Finally a way to get
  6.         your "too big" pictures into XiPaint...
  7.     Included JPeg support (esp. useful e.g. for downscaled loading)
  8.     Automatic installation script added.
  9. new in V3.0: TrueColor animation saving support in HHsYUVSq animation format
  10.     ->create your own TrueColor animations for playback on CyberGraphX
  11.       with CyberTVPlayer or on EGS with EGSTVPlayer <-
  12.     Including ARexx script for automatic conversion of picture
  13.       directories into HHsYUVSq animation format
  14.  
  15. This universal module can be used to load images in many file formats
  16. (more than 20 and additionally Datatypes) very fast into XiPaint (including
  17. optional downscaling) and to create TrueColor animations in HHsYUVSq
  18. animation format.
  19.  
  20. Warning: I am aware that illegal/modified keyfiles of this module may exist.
  21. !Use of such keyfiles ("hhsxipaintmodkey.library") is strictly prohibited and
  22. !can lead to undefined results and problems! For a program which you use
  23. !you should also be willing to pay the shareware fee. Only if enough users
  24. !register I will be able to do further improvements or create other graphic
  25. !applications. You can also help me by sending me illegal keyfiles of
  26. !this product which you find somewhere.
  27.  
  28. Installation
  29. ------------
  30.  
  31. The module can be installed automatically with the included script: Simply
  32. start it and select the XiPaint main directory in the file requester. The
  33. needed files will then be installed.
  34.  
  35. If you prefer manual installation: "hhsxipaintmod.xio" is the main module
  36. and should be copied to the XiPaint/Modules directory for XiPaint 3.2 and up.
  37. For older versions the module should be copied to the XiPaint main directory
  38. and the additional ARexx script "hhsxipaintloader.rx" should come into
  39. the XiPaint/Makro directory. For all versions the "makeanim.rx" script can
  40. be installed in the XiPaint/Makro or XiPaint main directory.
  41.  
  42. Usage
  43. -----
  44.  
  45. 1) XiPaint 3.2 or higher (incl. XiPaint 4.x): The module will be detected
  46.    by XiPaint
  47.  
  48.   a) as "HHsUniversalLoader", "Universal_50%_size" and "Universal_25%_size"
  49.      which you can then select in the Settings/Loaders list of loader
  50.      modules. The Loader will be automatically used (if selected) for
  51.      opening of new projects and for loading into existing projects.
  52.      To load pictures in half or quarter size, use the %_size loaders.
  53.  
  54.   b) as "HHsYUVSqAnimation" which you can then select in the Settings/Savers
  55.      list of saver modules. To create a new animation, select a new filename
  56.      for saving with this format; to append a frame to an existing animation,
  57.      select the existing animation file for saving. XiPaint will warn you
  58.      that the file is overwritten, but the module will only append the frame
  59.      and not delete the old file.
  60.  
  61.      Please note: Image width must be in the range 80 to 360 (even size will
  62.      be generated); Image height must be in the range 64 to 310. To append
  63.      frames to an animation, the image size in XiPaint must match the frame
  64.      size of the file you want to append to. Otherwise (or if you specify
  65.      not a HHsYUVSq anim file) an error will occur.
  66.  
  67.    To automatically create an animation from a directory of pictures you
  68.    can use the included ARexx script "makeanim.rx". This will do automatic
  69.    downscaling. Please see notes below.
  70.  
  71.    The module has been tested with XiPaint 3.2 and the new XiPaint 4.0!
  72.  
  73. -> XiPaint-CD: If you have problems with XiPaint on CD-ROM,
  74.    you should check your file system; some CD file systems
  75.    only support upper case file names; XiPrefs looks only for
  76.    lower case xout-libraries; use another file system or rename
  77.    the libraries to lowercase manually (on your harddisk) like
  78.    rename XiPaint/libs/XOUT_C.LIBRARY "XiPaint/libs/xout_c.library"
  79.    etc... This should solve your problems.
  80.  
  81. 2) XiPaint 3.0/3.1
  82.  
  83.   As thoose XiPaint versions have no direct support for external modules,
  84.   you can only access it by the included ARexx scripts.
  85.  
  86.   a) For loading: Execute the "hhsxipaintloader.rx" macro (with the
  87.      menu function Macro/Execute).
  88.      It will then switch to the WB screen and display a standard
  89.      file requester. You can then select a file for loading. The
  90.      picture will be loaded if possible and transferred to XiPaint
  91.      as a new project window. Then the WB screen is sent back so
  92.      that XiPaint screen should appear in front again. Some XiPaint
  93.      versions add absolute path names of new project windows to the
  94.      relative standard path. I can't work around this, so such
  95.      pictures will get wrong project names with such versions (Only
  96.      use SaveAs to save such pictures). Please upgrade to XiPaint 3.2
  97.      to get a more convenient access to my module...
  98.  
  99.   b) For TrueColor animation creation: Execute the automatic script
  100.      "makeanim.rx"; see below for details.
  101.  
  102. Supported file formats
  103. ----------------------
  104.  
  105. Supported file formats for loading:
  106.  
  107. * IFF-ILBM (all standard formats 1 to 8Bit, EHB, HAM6, HAM8, 24Bit)
  108. * JPeg (color and greyscale; see notes below)
  109. * PhotoCD (Base format 768x512 or 512x768 (portrait); linear 24Bit colors)
  110. * PPM/PGM/PBM (P1&P4 b&w, P5 grey, P6 color)
  111. * QRT (also known as dump format by PD raytracers as POV-Ray)
  112. * Targa (RLE compr.&uncompr. 1/8/15/16/24/32Bit;incl. interleaved)
  113. * PCX (compr.&uncompr. EGA1-4Bit, VGA 8Bit grey/Colormap and 24Bit)
  114. * MacPaint (b&w compressed 1Bit format; datafork only)
  115. * BMP (uncompr. 24Bit RGB,1Bit,4Bit or 8Bit Colormap; RLE compressed 8Bit,1Bit)
  116. * TIF (packbit-compr.&uncompr. 24Bit,1-8Bit grey/Color Motorola&Intel formats)
  117. * EGS7.x window iconification file format
  118. * DEEP (compr.&uncompr. 24Bit and 32Bit)
  119. * RGB formats (RGB8, RGBN, RGB5)
  120. * ACBM formats (1 to 8Bit, incl. HAM6/HAM8)
  121. * FBM formats (8Bit grey/color and 24Bit)
  122. * IFF-PBM (DPII) format
  123. * Sun raster (1Bit, 8Bit grey/color and 24Bit uncompressed)
  124. * YUV (color 1:1:1, 2:1:1, 4:1:1 and greyscale)
  125. * VLAB raw (color 1:1:1, 2:1:1, 4:1:1 and greyscale)
  126. * HHsYUVSq sequence format (sequential or random access; only first frame)
  127. * HHsXRL formats (1-8Bit ColorMap incl. HAM6/8, 8Bit grey, 24Bit RGB compressed)
  128. * binary-EPS bitmaps (RGB and CMYK; this function is experimental)
  129. * TBCPlus frames&fields
  130.  
  131. * DataType (incl. first frame of animations with Anim-Datatypes)
  132.  
  133. Supported file formats for saving:
  134.  
  135. * HHsYUVSq animation format
  136.  
  137. Automatic creation of HHsYUVSq TrueColor animations
  138. ---------------------------------------------------
  139.  
  140. With the script "makeanim.rx" you can automatically convert a directory
  141. of pictures into an HHsYUVSq animation file. Just start the script
  142. from XiPaint as macro or from Workbench or Shell. It should work with
  143. all XiPaint 3.x and up versions. If you start it from XiPaint, you will
  144. probably have to switch to WB screen manually; there you get a requester
  145. asking for the source directory which should contain the pictures
  146. (all of the same size). Then you are asked for the destination animation
  147. file. Then the automatic conversion is started. Pictures are downscaled
  148. if necessary. You can watch the pictures beeing loaded in XiPaint. They
  149. are loaded in alphabetical order (users of old XiPaint versions prior to
  150. V3.2 should NOT play with XiPaint during this process as this can
  151. block the whole system). With newer versions it should be save to
  152. use XiPaint for other things during the process except loading as
  153. this would interact with the frame loading! If the conversion has finished,
  154. the last picture will remain in XiPaint as a project. You can close
  155. this manually.
  156.  
  157. To play the animations use my freeware player programs
  158. CyberTVPlayer for TrueColor playback on CyberGraphX compatible
  159. boards (incl. Draco) or EGSTVPlayer for TrueColor playback on
  160. EGS compatible boards. CyberTVPlayer can also be used without
  161. CyberGraphX for reduced viewing (upto 256 colors) on all Amigas
  162. with at least OS3.0.
  163.  
  164. Additional notes: The loading/saving is done with HHsXiPaintMod.xio
  165. only; so you can only load pictures in one of the supported formats
  166. (see above). If you want to make animations from pictures in other formats,
  167. you have to load and save them with the appropriate modules manually.
  168. But anyway, the module now seems to support nearly all formats...
  169.  
  170. Downscaled loading
  171. ------------------
  172.  
  173. The loader module now supports direct downscaled loading in XiPaint 3.2
  174. and higher; simply select the appropriate loader version in the list.
  175. Currently the loader should appear 3 times: HHsUniversalLoader for full
  176. size, Universal_50%_Size for half size and Universal_25%_Size for quarter
  177. size. For most file formats (e.g. IFF, DEEP, JPeg, PCX, PPM, Targa, ...)
  178. the downscaling is done on a line by line base, so that memory will only
  179. be needed for the reduced size. This should enable you to get big
  180. pictures into XiPaint without memory problems.
  181.  
  182. General notes
  183. -------------
  184.  
  185. There are currently no error requesters for loading (if a file can not be
  186. loaded nothing will happen). For saving error requesters are included.
  187.  
  188. If you register for the XiPaint modules you will receive a
  189. keyfile together with the latest version of the modules. The
  190. keyfile will enable you to use future demo versions as update.
  191.  
  192. The demo version will load and save all pictures in greyscales, but
  193. usually at the same speed as the full version would do in color.
  194.  
  195. XiPaintModules need at least OS2.04 (OS3.x for Datatype usage).
  196.  
  197. All loading functions (except JPeg: This software is based in part on the work
  198. of the independent JPeg Group) have been written in Assembler and optimised for
  199. extremely high speed. An exception to this is the JPeg format, which is
  200. written in C and based on the usual code of the indipendent JPeg group.
  201. I created the fast loading functions mainly for my famous shareware programs
  202. *** CyberShow Professional *** (universal viewer and slideshow program
  203. for all OS3.x Amigas and Dracos and esp. for CyberGraphX users), EGSPhotoAlbum
  204. Prof. and EGS-TV Prof.; When new formats are implemented for my other
  205. programs (or the speed is improved further), I will usually also update
  206. the modules, which registered user can then use due to the keyfile concept.
  207.  
  208. The JPeg format has been included in this module mainly for the comfort
  209. of the users (as otherwise for JPeg another loader module would have to
  210. be seleted) and to enable JPeg loading in downscaled form, which can be
  211. very useful. Now you can also create animations in HHsYUVSq animation
  212. format from JPeg pictures with the automatic ARexx script. The loading
  213. speed of the JPeg code (for pictures in full size) is unfortunately
  214. currently not very fast. Downscaled loading of JPeg can be much faster.
  215.  
  216. Registration
  217. ------------
  218.  
  219. You can register for the module at the small add-on price of only 8US$ or
  220. 10DM if you order it together with one of my other shareware programs,
  221. e.g. CyberShow, the universal viewer and slideshow program for all Amigas
  222. with at least OS3.0 (loading the same formats as the XiPaintModule)
  223. or EGSPhotoAlbum or EGS-TV. Please use the registration forms of thoose
  224. programs and specify your add-on module order there and include the
  225. extra amount.
  226.  
  227. Otherwise you should use the included registration form to register:
  228.  
  229. If you only want to register for the module, the registration fee is
  230. 18US$ outside europe or 20DM in europe. You will also get the latest demo
  231. versions of my other programs. Additional modules (e.g. UniversalGIO for
  232. Photogenics or FastIFXModules for ImageFX) can be ordered at the lower
  233. add-on price.
  234.  
  235. If you are already a registered user of one of my programs and now want to
  236. register for the modules, the registration fee is 13US$ outside europe or
  237. 15DM (in europe). Additional modules (e.g. UniversalGIO for Photogenics or
  238. FastIFXModules for ImageFX) can be ordered at the lower add-on price.
  239.  
  240. (Special note for users in germany only: Wenn Sie schon registrierter Benutzer
  241.  eines meiner Shareware-Programme sind und sich Ihre Anschrift nicht
  242.  geändert hat, können Sie die Module direkt per Überweisung bestellen.
  243.  Als Verwendungszweck geben Sie bitte "XiPaintMod für ...." an, wobei Sie
  244.  das Programm was Sie schon haben und die Registriernummer angeben.
  245.  Zusätzlich möglichst auch noch Name/Anschrift; die Bankverbindung:
  246.  Konto-Nr. 5740147 BLZ 310 500 00 Stadtspark. Mönchengladbach)
  247.  (No bank transfers from outside germany!)
  248.  
  249. Send your filled in registration form together with cheque, international
  250. postal money order or banknotes to:
  251.  
  252.     Helmut Hoffmann
  253.     Rubensstrasse 4
  254.     D-41063 Moenchengladbach
  255.     Germany
  256.  
  257. Special Thanks
  258. --------------
  259.  
  260. My special thanks go to Mr. Thomas Dorn and Ossowski's Schatztruhe for
  261. providing me with XiPaint.
  262.  
  263. Disclaimer
  264. ----------
  265.  
  266. This software (program and documentation) is provided "as is" and
  267. comes with no warranty, either expressed or implied.
  268. The author is in no way responsible for any damage or loss that may
  269. occur due to direct or indirect usage of this software. You use
  270. this software entirely at your own risk.
  271.  
  272. Copyright and Distribution
  273. --------------------------
  274.  
  275. HHsFastUniversalXiPaintModule (module and documentation) is copyright by
  276.  
  277.     Helmut Hoffmann
  278.     Rubensstrasse 4
  279.     D-41063 Moenchengladbach
  280.     Germany
  281.  
  282. The demo version may be freely distributed and used as
  283. long as the following conditions are met:
  284.  
  285. 1) All files have to be kept together
  286.  
  287. 2) No file may be modified or crunched/packed.
  288.  
  289.    The only official way to distribute the demo packed is the
  290.    original xipaintmod.lha archive.
  291.    The modules may not be disassembled or analysed. The limitations
  292.    integrated in the demo version may under no circumstance be removed
  293.    or bypassed.
  294.  
  295. 3) Distributors may only charge for the duplication process (including media)
  296.    and not for the software. Theese charges may not exceed the following
  297.    limits: a) Demo on a PD-disk: 7$ (US-dollar) including
  298.               postage&packing (in Germany: 10DM)
  299.        b) Demo on a PD-CD-ROM: 40$ (US-dollar) including
  300.               postage&packing (in Germany: 60DM)
  301.        c) Demo on a BBS/Mailbox/ftp-site or other electronically
  302.               callable system: Maximum charge 3$ (US-dollar) (in Germany: 5DM)
  303.               for downloading
  304.    Anyway, it must be made explictly clear to the buyer, that he does not
  305.    pay for the modules (demo) itself but only for the duplication service.
  306.  
  307. 4) It is not allowed to distribute this demo with any commercial product
  308.    without a written permission by me. One exception is the distribution of
  309.    the demo version with products not exceeding the above price limits (e.g.
  310.    a cover-disk magazine for 7$ or less).
  311.  
  312.    The following companies have my explicit permission to distribute the
  313.    demo with their products: Ingenieurbüro Helfrich, MacroSystem.
  314.    The demo version may also be included with the XiPaint software.
  315.  
  316. 5) The registered version may not be redistributed. It may only run on one
  317.    machine per registration. It is allowed to make a backup copy of the
  318.    original disk.
  319.  
  320. Version history
  321. ---------------
  322.  
  323. V0.1 (7th aug. 95): Prerelease for loading functions
  324. V0.2 (20th aug. 95): Prerelease for loading by ARexx script:
  325.             added Request option and screen switching functions
  326. V1.0 (15th sep. 95): First official release for use by Arexx script (usable
  327.             with XiPaint 3.x)
  328. V2.0 (21st sep. 95): First release with direct loader module support for
  329.             XiPaint 3.2 (just copy the .xio file into the
  330.             XiPaint/Modules directory and configure it as loader)
  331. V2.1 (9th oct. 95): Extended TIF loader to support "Intel" byte order files
  332.             and more variants
  333. V3.0 (11th dec. 95): TrueColor animation saving: extended module to support
  334.             saving in HHsYUVSq animation format;
  335.             included ARexx script to automatically create such
  336.             animations from multiple pictures
  337.              Extended IFF loader to accept 0-sized chunks
  338.              Loader can now load bigger pictures into smaller projects
  339.              Integrated downscaling support (only usable by scripts)
  340. V4.0 (9th feb. 96): Support for downscaled loading (50% size, 25% size) by
  341.             additional entries in the XiPaint 3.2 loader list
  342.             Added JPeg loading support (see special notes for JPeg!)
  343.             Included script for automatic installation of modules
  344.             Bug fixes in makeanim.rx script: now should also work
  345.             if other project windows exist during anim creation
  346.             Extended IFF loader to accept unusual sized color maps
  347. V4.1 (24th march 96): Changed PCX loading for more compatibility
  348. V4.2/3 (29th april 96): Extended PCX loading for even more compatibility
  349.  
  350.